home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 1 / Meeting Pearls Vol 1 (1994).iso / installed_progs / gfx / daggex / docs / clients / xauth.doc < prev    next >
Encoding:
Text File  |  1994-06-04  |  10.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4. XAUTH(1)                                                 XAUTH(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        xauth - X authority file utility
  9.  
  10. SSYYNNOOPPSSIISS
  11.        xxaauutthh [-f _a_u_t_h_f_i_l_e] [-vqib] [_c_o_m_m_a_n_d _a_r_g_._._.]
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        The  _x_a_u_t_h  program is used to edit and display the autho-
  15.        rization information used in connecting to the  X  server.
  16.        This  program  is usually to extract authorization records
  17.        from one machine and merge them in on another (as  is  the
  18.        case  when using remote logins or to grant access to other
  19.        users).  Commands (described below) may be entered  inter-
  20.        actively,  on the _x_a_u_t_h command line, or in scripts.  Note
  21.        that this program does nnoott contact the X server.
  22.  
  23. OOPPTTIIOONNSS
  24.        The following options may be used with _x_a_u_t_h.  They may be
  25.        given  individually  (e.g.  _-_q  _-_i)  or may combined (e.g.
  26.        _-_q_i):
  27.  
  28.        --ff _a_u_t_h_f_i_l_e
  29.                This option specifies the name  of  the  authority
  30.                file  to use.  By default, _x_a_u_t_h will use the file
  31.                specified by the XAUTHORITY  environment  variable
  32.                or _._X_a_u_t_h_o_r_i_t_y in the user's home directory.
  33.  
  34.        --qq      This  option  indicates  that _x_a_u_t_h should operate
  35.                quietly and not print unsolicited status messages.
  36.                This  is  the  default  if  an _x_a_u_t_h command is is
  37.                given on the command line or if the standard  out-
  38.                put is not directed to a terminal.
  39.  
  40.        --vv      This  option  indicates  that _x_a_u_t_h should operate
  41.                verbosely and print status messages indicating the
  42.                results  of  various  operations  (e.g.  how  many
  43.                records have been read in or written  out).   This
  44.                is  the  default if _x_a_u_t_h is reading commands from
  45.                its standard input  and  its  standard  output  is
  46.                directed to a terminal.
  47.  
  48.        --ii      This option indicates that _x_a_u_t_h should ignore any
  49.                authority file locks.  Normally, _x_a_u_t_h will refuse
  50.                to read or edit any authority files that have been
  51.                locked by other programs (usually _x_d_m  or  another
  52.                _x_a_u_t_h).
  53.  
  54.        --bb      This option indicates that _x_a_u_t_h should attempt to
  55.                break any authority file locks  before  proceeding
  56.                and should only be used to clean up stale locks.
  57.  
  58. CCOOMMMMAANNDDSS
  59.        The following commands may be used to manipulate authority
  60.        files:
  61.  
  62.  
  63.  
  64. X Version 11                Release 5                           1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XAUTH(1)                                                 XAUTH(1)
  71.  
  72.  
  73.        aadddd _d_i_s_p_l_a_y_n_a_m_e _p_r_o_t_o_c_o_l_n_a_m_e _h_e_x_k_e_y
  74.                An authorization entry for the  indicated  display
  75.                using  the given protocol and key data is added to
  76.                the authorization file.  The data is specified  as
  77.                an  even-lengthed  string  of  hexadecimal digits,
  78.                each pair representing one octet.  The first digit
  79.                of  each pair gives the most significant 4 bits of
  80.                the octet and the second digit  of  the  pairgives
  81.                the  least  significant 4 bits.  For example, a 32
  82.                character hexkey would represent a 128-bit  value.
  83.                A protocol name consisting of just a single period
  84.                is  treated  as  an  abbreviation  for  _M_I_T_-_M_A_G_I_C_-
  85.                _C_O_O_K_I_E_-_1.
  86.  
  87.        [[nn]]eexxttrraacctt _f_i_l_e_n_a_m_e _d_i_s_p_l_a_y_n_a_m_e_._._.
  88.                Authorization  entries  for  each of the specified
  89.                displays are written to the  indicated  file.   If
  90.                the  _n_e_x_t_r_a_c_t  command  is  used,  the entries are
  91.                written in a  numeric  format  suitable  for  non-
  92.                binary  transmission  (such  as  secure electronic
  93.                mail).  The extracted entries can be read back  in
  94.                using  the  _m_e_r_g_e and _n_m_e_r_g_e commands.  If the the
  95.                filename consists  of  just  a  single  dash,  the
  96.                entries will be written to the standard output.
  97.  
  98.        [[nn]]lliisstt [_d_i_s_p_l_a_y_n_a_m_e...]
  99.                Authorization  entries  for  each of the specified
  100.                displays (or all if no  displays  are  named)  are
  101.                printed on the standard output.  If the _n_l_i_s_t com-
  102.                mand is used, entries will be shown in the numeric
  103.                format  used  by  the _n_e_x_t_r_a_c_t command; otherwise,
  104.                they are shown in a textual format.  Key  data  is
  105.                always  displayed  in the hexadecimal format given
  106.                in the description of the _a_d_d command.
  107.  
  108.        [[nn]]mmeerrggee [_f_i_l_e_n_a_m_e...]
  109.                Authorization entries are read from the  specified
  110.                files   and  are  merged  into  the  authorization
  111.                database,  superceding   any   matching   existing
  112.                entries.  If  the  _n_m_e_r_g_e  command  is  used,  the
  113.                numeric format given in  the  description  of  the
  114.                _e_x_t_r_a_c_t  command  is used.  If a filename consists
  115.                of just a single dash, the standard input will  be
  116.                read if it hasn't been read before.
  117.  
  118.        rreemmoovvee _d_i_s_p_l_a_y_n_a_m_e...
  119.                Authorization  entries matching the specified dis-
  120.                plays are removed from the authority file.
  121.  
  122.        ssoouurrccee _f_i_l_e_n_a_m_e
  123.                The specified file is treated as a script contain-
  124.                ing  _x_a_u_t_h  commands  to execute.  Blank lines and
  125.                lines beginning with a sharp sign (#) are ignored.
  126.                A single dash may be used to indicate the standard
  127.  
  128.  
  129.  
  130. X Version 11                Release 5                           2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XAUTH(1)                                                 XAUTH(1)
  137.  
  138.  
  139.                input, if it hasn't already been read.
  140.  
  141.        iinnffoo    Information  describing  the  authorization  file,
  142.                whether  or  not  any  changes have been made, and
  143.                from  where  _x_a_u_t_h  commands  are  being  read  is
  144.                printed on the standard output.
  145.  
  146.        eexxiitt    If any modifications have been made, the authority
  147.                file is written out (if allowed), and the  program
  148.                exits.   An  end of file is treated as an implicit
  149.                _e_x_i_t command.
  150.  
  151.        qquuiitt    The program  exits,  ignoring  any  modifications.
  152.                This  may  also  be  accomplished  by pressing the
  153.                interrupt character.
  154.  
  155.        hheellpp [[_s_t_r_i_n_g]]
  156.                A description of all commands that begin with  the
  157.                given  string  (or  all  commands  if no string is
  158.                given) is printed on the standard output.
  159.  
  160.        ??       A short list of the valid commands is  printed  on
  161.                the standard output.
  162.  
  163. DDIISSPPLLAAYY NNAAMMEESS
  164.        Display  names for the _a_d_d, _[_n_]_e_x_t_r_a_c_t, _[_n_]_l_i_s_t, _[_n_]_m_e_r_g_e,
  165.        and _r_e_m_o_v_e commands use the same  format  as  the  DISPLAY
  166.        environment  variable and the common _-_d_i_s_p_l_a_y command line
  167.        argument.   Display-specific  information  (such  as   the
  168.        screen  number) is unnecessary and will be ignored.  Same-
  169.        machine connections (such as  local-host  sockets,  shared
  170.        memory,  and the Internet Protocol hostname _l_o_c_a_l_h_o_s_t) are
  171.        referred to as _h_o_s_t_n_a_m_e/unix:_d_i_s_p_l_a_y_n_u_m_b_e_r so  that  local
  172.        entries  for  different  machines  may  be  stored  in one
  173.        authority file.
  174.  
  175. EEXXAAMMPPLLEE
  176.        The most common use for _x_a_u_t_h is to extract the entry  for
  177.        the current display, copy it to another machine, and merge
  178.        it into the user's authority file on the remote machine:
  179.  
  180.                %  xauth extract - $DISPLAY | rsh other xauth merge -
  181.  
  182. EENNVVIIRROONNMMEENNTT
  183.        This _x_a_u_t_h program uses the  following  environment  vari-
  184.        ables:
  185.  
  186.        XXAAUUTTHHOORRIITTYY
  187.                to  get  the  name of the authority file to use if
  188.                the _-_f option isn't used.  If this variable is not
  189.                set, _x_a_u_t_h will use _._X_a_u_t_h_o_r_i_t_y in the user's home
  190.                directory.
  191.  
  192.        HHOOMMEE    to get the user's  home  directory  if  XAUTHORITY
  193.  
  194.  
  195.  
  196. X Version 11                Release 5                           3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XAUTH(1)                                                 XAUTH(1)
  203.  
  204.  
  205.                isn't defined.
  206.  
  207. BBUUGGSS
  208.        Users  that have unsecure networks should take care to use
  209.        encrypted file transfer mechanisms to  copy  authorization
  210.        entries   between  machines.   Similarly,  the  _M_I_T_-_M_A_G_I_C_-
  211.        _C_O_O_K_I_E_-_1 protocol is not very useful in unsecure  environ-
  212.        ments.   Sites  that are interested in additional security
  213.        may need to use encrypted authorization mechanisms such as
  214.        Kerberos.
  215.  
  216.        Spaces  are  currently  not  allowed in the protocol name.
  217.        Quoting could be added for the truly perverse.
  218.  
  219. CCOOPPYYRRIIGGHHTT
  220.        Copyright 1989, Massachusetts Institute of Technology.
  221.        See _X_(_1_) for a full statement of rights and permissions.
  222.  
  223. AAUUTTHHOORR
  224.        Jim Fulton, MIT X Consortium
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. X Version 11                Release 5                           4
  263.  
  264.  
  265.